home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Collection of Tools & Utilities
/
Collection of Tools and Utilities.iso
/
tex
/
off_09.zip
/
READER.OFF
< prev
next >
Wrap
Text File
|
1993-01-12
|
4KB
|
157 lines
%startcol 10
%endcol 70
%parindent 0
%defmacro off
%bold OFF %norm %endmacro
%defmacro title
%norm
%verb
%verb
%endmacro
%begin verb
-----------------------------------------------------------------------------
%bold __ ___ ___
/ \\ |__ |__
\\__/ | |
%norm
An Informal Documentation Formatter
-----------------------------------------------------------------------------
%end
%center %rev READER'S GUIDE
%center %bold Vassilis V. Dimakopoulos
%verb
%verb
%center --- Last Revision: May 1992 ---
%norm
%newpage
%center %under Quick overview
%title
To use %off make sure that %bold off.exe %norm is
in a directory where MSDOS can find it (e.g. in one of the directories
in your PATH variable). If you want to browse through the file 'fname'
then type
%center off fname
When browsing through the document you can press the following keys:
%list
%item SPACE or
%item ENTER to go to the next page
%item Q to quit the program.
%endlist
%off can also save the document in a file or print it directly to a
line printer.
%newpage
%under %center Plain output
%title
If you want to convert a document file into a plain - with no
screen attributes - file then type:
%center off -a fname > newfname
and the file 'newfname' will contain plain ascii text. Note that the '-a'
option is necessary because the normal output of %off %under cannot
%norm be redirected to a file.
%title
%center %under Printer output
%title
%off can sent a document file directly to a %under line %norm printer
(which supports the IBM escape sequences) using the '-p' option:
%center off -p fname
%under NOTES: %norm
%list 1
%item The characters that appear with reversed background / foreground
on the screen, appear as %rev italics %norm on the line printer.
%item %off assumes by default that a %bold NLQ %norm (Near-Letter-Quality)
printing is needed. To override this use the '-d' option:
%center off -p -d fname
and the printer will use %bold draft %norm quality characters.
%item While the screen output is the default for %off (and consequently
the page length is 24 lines), when the '-p' or '-a' option is used,
the page length becomes by default %bold 66 %norm lines. You may need
to adjust this to your printer page length (or to whatever you want)
using the '-l' option. For example
%center off -p -l 54 fname
will set the page length to a usual single-sheet printer page.
%item Similarly the '-p' and '-a' options cause the page width to be
initialized to 91 columns. Adjust this with the '-w' option, e.g.
%center off -p -w 80 fname
%endlist
Note that the '-d' option is ignored if the '-p' option is not used and
that the '-l' and '-w' options can be used not only for printer but for
screen output too.
%newpage
%center %under Filenames
%title
To browse through 'fname' you do not need to specify an extension.
If you give one %off will take it into consideration otherwise it
will supply some extensions by itself. The extensions
%off gives to 'fname' (in the order shown) are
%list 1
%item The user extension (if any given)
%item .off
%item .doc
%item .txt
%endlist
Also you do not have to give the full path on which 'fname' resides.
%off will first look for an environmental variable called
%bold OFFPATH %norm which has the directories where the documentation
files can normaly be found. Then %off will search for 'fname' in the
following directories (in the order shown):
%list 1
%item The current directory.
%item The directories in your %bold OFFPATH %norm (if it exists).
%endlist
Note that %off will search in the following manner:
%begin verb
for each extension
{
for each directory
{
if "directory\\file.extension" found
then Done.
else
Continue.
}
}
%end